.NET Framework Class Library |
Parallel..::.ForEach<(Of <(TSource, TLocal>)>) Method (Partitioner<(Of <(TSource>)>), ParallelOptions, Func<(Of <(TLocal>)>), Func<(Of <(TSource, ParallelLoopState, TLocal, TLocal>)>), Action<(Of <(TLocal>)>)) |
Parallel Class See Also Send Feedback |
Namespace:
System.Threading.Tasks
Assembly:
System.Threading (in System.Threading.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Shared Function ForEach(Of TSource, TLocal) ( _ source As Partitioner(Of TSource), _ parallelOptions As ParallelOptions, _ localInit As Func(Of TLocal), _ body As Func(Of TSource, ParallelLoopState, TLocal, TLocal), _ localFinally As Action(Of TLocal) _ ) As ParallelLoopResult |
C# |
---|
public static ParallelLoopResult ForEach<TSource, TLocal>( Partitioner<TSource> source, ParallelOptions parallelOptions, Func<TLocal> localInit, Func<TSource, ParallelLoopState, TLocal, TLocal> body, Action<TLocal> localFinally ) |
Parameters
- source
- Type: System.Collections.Concurrent..::.Partitioner<(Of <(TSource>)>)
The Partitioner that contains the original data source.
- parallelOptions
- Type: System.Threading.Tasks..::.ParallelOptions
A ParallelOptions instance that configures the behavior of this operation.
- localInit
- Type: System..::.Func<(Of <(TLocal>)>)
The function delegate that returns the initial state of the local data for each thread.
- body
- Type: System..::.Func<(Of <(TSource, ParallelLoopState, TLocal, TLocal>)>)
The delegate that is invoked once per iteration.
- localFinally
- Type: System..::.Action<(Of <(TLocal>)>)
The delegate that performs a final action on the local state of each thread.
Type Parameters
- TSource
- The type of the elements in source.
- TLocal
- The type of the thread-local data.
Return Value
A ParallelLoopResult structure that contains information on what portion of the loop completed.Remarks
The Partitioner is used to retrieve the elements to be processed, in place of the original data source. If the current element's index is desired, the source must be an OrderablePartitioner.
The body delegate is invoked once for each element in the source Partitioner. It is provided with the following parameters: the current element, a ParallelLoopState instance that may be used to break out of the loop prematurely, and some local state that may be shared amongst iterations that execute on the same thread.
The localInit delegate is invoked once for each thread that participates in the loop's execution and returns the initial local state for each of those threads. These initial states are passed to the first body invocations on each thread. Then, every subsequent body invocation returns a possibly modified state value that is passed to the next body invocation. Finally, the last body invocation on each thread returns a state value that is passed to the localFinally delegate. The localFinally delegate is invoked once per thread to perform a final action on each thread's local state.
Exceptions
Exception | Condition |
---|---|
System..::.ArgumentNullException | The exception that is thrown when the source argument is null. |
System..::.ArgumentNullException | The exception that is thrown when the parallelOptions argument is null. |
System..::.ArgumentNullException | The exception that is thrown when the body argument is null. |
System..::.ArgumentNullException | The exception that is thrown when the localInit argument is null. |
System..::.ArgumentNullException | The exception that is thrown when the localFinally argument is null. |
System..::.OperationCanceledException | The exception that is thrown when the CancellationToken in the parallelOptions argument is set |
System..::.InvalidOperationException | The exception that is thrown when the SupportsDynamicPartitions property in the source Partitioner returns false. |
System..::.InvalidOperationException | The exception that is thrown when any methods in the source Partitioner return null. |
System..::.InvalidOperationException | The exception that is thrown when the GetPartitions() method in the source Partitioner does not return the correct number of partitions. |
System..::.InvalidOperationException | The exception that is thrown when the GetPartitions() method in the source Partitioner returns an IList with at least one null value. |
System..::.InvalidOperationException | The exception that is thrown when the GetDynamicPartitions() method in the source Partitioner returns an IEnumerable whose GetEnumerator() method returns null. |
System..::.AggregateException | The exception that is thrown to contain an exception thrown from one of the specified delegates. |
System..::.ObjectDisposedException | The exception that is thrown when the the CancellationTokenSource associated with the the CancellationToken in the parallelOptions has been disposed. |